Оператор [note]

Описание

Оператор [note] позволяет добавить к логическому узлу название, аннотацию или краткое описание его назначения. Это полезно для:

• Понимания, для чего предназначен узел и какие функции он выполняет;
• Улучшения читаемости правил;
• Отображения пояснительных сообщений в отладочном режиме (applogic debug).

Текст из [note] выводится в логах и в интерфейсе отладки, помогая инженерам быстро понимать логику узла без необходимости читать весь код.

Оператор [note] может использоваться в любом узле и обычно размещается среди первых операторов.

Пример

-- Узел "N1_sim_ready"
--------------------------------------
-- Проверка готовности SIM-карты в GSM-модеме
sim_ready = {
    {
        ["note"] = "Определяем наличие Сим-карты в слоте GSM-модема",
    },

    {
        ["load-ubus"] = function(nodes)
            return {
                ubus   = "tsmodem.driver",
                method = "cpin",
                params = {},
            }
        end,
    },

    {
        ["note"] = "Переключаем слоты Сим-карт если Симка не найдена",
    },

    {
        ["switch_slot"] = function(nodes)
            -- логика переключения слота SIM-карты
        end,
    },
}

Как это работает

• Оператор [note] не влияет на логику выполнения узла — он чисто информационный.
• Можно размещать несколько операторов [note] внутри одного узла (например, перед разными блоками логики).
• Текст из [note] особенно полезен в режиме отладки applogic debug, где он отображается вместе с выполняемыми операторами.

Рекомендация

Всегда добавляйте [note] к сложным или важным узлам — это значительно упрощает сопровождение и отладку правил.